home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zhpevx.z / zhpevx
Encoding:
Text File  |  2002-10-03  |  7.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZHPEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian matrix A in packed storage
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZHPEVX( JOBZ, RANGE, UPLO, N, AP, VL, VU, IL, IU, ABSTOL, M,
  14.                         W, Z, LDZ, WORK, RWORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, M, N
  19.  
  20.          DOUBLE         PRECISION ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          DOUBLE         PRECISION RWORK( * ), W( * )
  25.  
  26.          COMPLEX*16     AP( * ), WORK( * ), Z( LDZ, * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      ZHPEVX computes selected eigenvalues and, optionally, eigenvectors of a
  43.      complex Hermitian matrix A in packed storage. Eigenvalues/vectors can be
  44.      selected by specifying either a range of values or a range of indices for
  45.      the desired eigenvalues.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      JOBZ    (input) CHARACTER*1
  50.              = 'N':  Compute eigenvalues only;
  51.              = 'V':  Compute eigenvalues and eigenvectors.
  52.  
  53.      RANGE   (input) CHARACTER*1
  54.              = 'A': all eigenvalues will be found;
  55.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  56.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangle of A is stored;
  76.              = 'L':  Lower triangle of A is stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrix A.  N >= 0.
  80.  
  81.      AP      (input/output) COMPLEX*16 array, dimension (N*(N+1)/2)
  82.              On entry, the upper or lower triangle of the Hermitian matrix A,
  83.              packed columnwise in a linear array.  The j-th column of A is
  84.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  85.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  86.              j)/2) = A(i,j) for j<=i<=n.
  87.  
  88.              On exit, AP is overwritten by values generated during the
  89.              reduction to tridiagonal form.  If UPLO = 'U', the diagonal and
  90.              first superdiagonal of the tridiagonal matrix T overwrite the
  91.              corresponding elements of A, and if UPLO = 'L', the diagonal and
  92.              first subdiagonal of T overwrite the corresponding elements of A.
  93.  
  94.      VL      (input) DOUBLE PRECISION
  95.              VU      (input) DOUBLE PRECISION If RANGE='V', the lower and
  96.              upper bounds of the interval to be searched for eigenvalues. VL <
  97.              VU.  Not referenced if RANGE = 'A' or 'I'.
  98.  
  99.      IL      (input) INTEGER
  100.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  101.              order) of the smallest and largest eigenvalues to be returned.  1
  102.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  103.              referenced if RANGE = 'A' or 'V'.
  104.  
  105.      ABSTOL  (input) DOUBLE PRECISION
  106.              The absolute error tolerance for the eigenvalues.  An approximate
  107.              eigenvalue is accepted as converged when it is determined to lie
  108.              in an interval [a,b] of width less than or equal to
  109.  
  110.              ABSTOL + EPS *   max( |a|,|b| ) ,
  111.  
  112.              where EPS is the machine precision.  If ABSTOL is less than or
  113.              equal to zero, then  EPS*|T|  will be used in its place, where
  114.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  115.              AP to tridiagonal form.
  116.  
  117.              Eigenvalues will be computed most accurately when ABSTOL is set
  118.              to twice the underflow threshold 2*DLAMCH('S'), not zero.  If
  119.              this routine returns with INFO>0, indicating that some
  120.              eigenvectors did not converge, try setting ABSTOL to
  121.              2*DLAMCH('S').
  122.  
  123.              See "Computing Small Singular Values of Bidiagonal Matrices with
  124.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  125.              Working Note #3.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))                                                          ZZZZHHHHPPPPEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      M       (output) INTEGER
  141.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  142.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  143.  
  144.      W       (output) DOUBLE PRECISION array, dimension (N)
  145.              If INFO = 0, the selected eigenvalues in ascending order.
  146.  
  147.      Z       (output) COMPLEX*16 array, dimension (LDZ, max(1,M))
  148.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  149.              the orthonormal eigenvectors of the matrix A corresponding to the
  150.              selected eigenvalues, with the i-th column of Z holding the
  151.              eigenvector associated with W(i).  If an eigenvector fails to
  152.              converge, then that column of Z contains the latest approximation
  153.              to the eigenvector, and the index of the eigenvector is returned
  154.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  155.              user must ensure that at least max(1,M) columns are supplied in
  156.              the array Z; if RANGE = 'V', the exact value of M is not known in
  157.              advance and an upper bound must be used.
  158.  
  159.      LDZ     (input) INTEGER
  160.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  161.              'V', LDZ >= max(1,N).
  162.  
  163.      WORK    (workspace) COMPLEX*16 array, dimension (2*N)
  164.  
  165.      RWORK   (workspace) DOUBLE PRECISION array, dimension (7*N)
  166.  
  167.      IWORK   (workspace) INTEGER array, dimension (5*N)
  168.  
  169.      IFAIL   (output) INTEGER array, dimension (N)
  170.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  171.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  172.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  173.              is not referenced.
  174.  
  175.      INFO    (output) INTEGER
  176.              = 0:  successful exit
  177.              < 0:  if INFO = -i, the i-th argument had an illegal value
  178.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  179.              indices are stored in array IFAIL.
  180.  
  181. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  182.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  183.  
  184.      This man page is available only online.
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.